home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / tools / shell-tools / wbstart / dev / wbstart.doc < prev    next >
Text File  |  1996-03-13  |  3KB  |  87 lines
  1. TABLE OF CONTENTS
  2.  
  3. wbstart.library/WBStartTagList
  4.  
  5. wbstart.library/WBStartTagList                  wbstart.library/WBStartTagList
  6. wbstart.library/WBStartTags                         wbstart.library/WBStartTags
  7.  
  8.    NAME
  9.         WBStartTagList -- Start a program as WB program
  10.  
  11.    SYNOPSIS
  12.         success = WBStartTagList(tags)
  13.         D0                       A0
  14.  
  15.         LONG WBStartTagList(struct TagItem *)
  16.  
  17.         success = WBStartTags(tag1, ...)
  18.  
  19.         LONG WBStartTags(Tag, ...)
  20.  
  21.    FUNCTION
  22.         Start a file as WB program.
  23.  
  24.         The following tags are currently supported. All information is copied
  25.         so you can free the resources after the library call.
  26.  
  27.          WBStart_Name            (const char *)
  28.  
  29.             Name of the file to start. It may be the name of a program, a tool
  30.             or a project. If the name does not contain an absolute path name
  31.             then the file will be searched relative to WBStart_DirectoryName
  32.             or WBStart_DirectoryLock.
  33.  
  34.             This tag must be specified. Otherwise WBStartTagList() will fail.
  35.  
  36.          WBStart_DirectoryName   (const char *)
  37.  
  38.             Name of a directory where the search for WBStart_Name starts.
  39.             Mutually exclusive to WBStart_DirectoryLock.
  40.  
  41.          WBStart_DirectoryLock   (BPTR)
  42.  
  43.             Lock of a directory where the search for WBStart_Name starts.
  44.             Mutually exclusive to WBStart_DirectoryName.
  45.  
  46.             If neither WBStart_DirectoryName or WBStart_DirectoryLock is
  47.             specified then the current directory of the internal handler
  48.             will be used. WBStart_Name should contain an absolute path name
  49.             in this case.
  50.  
  51.          WBStart_Stack           (ULONG)
  52.  
  53.             Stack size of the new process. A larger stack setting in the tool
  54.             or project icons overrides this value.
  55.  
  56.             Default: 4096 Bytes
  57.  
  58.          WBStart_Priority        (LONG)
  59.  
  60.             Priority of the new process.
  61.  
  62.             Default: 0
  63.  
  64.          WBStart_ArgumentsCount  (ULONG)
  65.  
  66.             Number of arguments in the list specified by WBStart_ArgumentList.
  67.  
  68.             Default: 0
  69.  
  70.          WBStart_ArgumentList    (struct WBArg *)
  71.  
  72.             Pointer to an array of Workbench arguments. This list will be
  73.             appended to the argument list for the tool.
  74.  
  75.             If a list is specified then WBStart_ArgumentsCount must be
  76.             specified too, otherwise WBStartTagList() will fail.
  77.  
  78.             Default: NULL, i.e. no argument list
  79.  
  80.    INPUTS
  81.         tags - list of TagItems
  82.  
  83.    RESULTS
  84.         success - RETURN_OK if the program could be started
  85.  
  86.  
  87.